home *** CD-ROM | disk | FTP | other *** search
/ The Games Machine 131 / XENIATGM131.iso / Goodies / I-WAR 2 Egde of Chaos - New SDK / IW2-EOC_Pog_Scripting_SDK.exe / include / iLoadout.h < prev    next >
C/C++ Source or Header  |  2002-01-14  |  7KB  |  318 lines
  1. //
  2. // (c) 1999 Particle Systems Ltd. All Rights Reserved
  3. //
  4. // iLoadout.h
  5. //
  6. // Pog header file for the iLoadout package.
  7. //
  8. // Revision control information:
  9. //
  10. // $Header:
  11. //
  12.  
  13. #include "Flux.h"
  14.  
  15. #ifdef FLUX_COMPILE
  16.  
  17. FLUX_DECLARE_EXTENSION(iLoadout);
  18.  
  19. #ifdef FLUX_LIB
  20. #if _MSC_VER >= 1000
  21. #pragma comment( lib, "iloadout" )
  22. #endif // _MSC_VER >= 1000
  23. #endif // FLUX_LIB
  24.  
  25. #else
  26.  
  27. // Dependencies ///////////////////////////////////////////////////////////////
  28.  
  29. uses iShip;
  30.  
  31. // Type definitions ///////////////////////////////////////////////////////////
  32.  
  33. // Enumeration of ship types. Must tie in with the enumeration values in the
  34. // icLoadout class.
  35. enum eShip
  36. { 
  37.     S_CommandSection, 
  38.     S_Tug,
  39.     S_FastAttackShip,
  40.     S_HeavyCorvette,
  41.     S_StormPetrel,
  42.     S_Count
  43. };
  44.  
  45. // The various loadout options.
  46. enum eLoadout
  47. {
  48.     L_Empty,
  49.     L_Standard,
  50.     L_Assault,
  51.     L_Stealth,
  52.     L_ECM,
  53.     L_Custom1,
  54.     L_Custom2,
  55.     L_Count
  56. };
  57.  
  58. // The success of a rearming operation - see iLoadout.RearmFromJaffs.
  59. // Maintain in parallel with icLoadout.
  60. enum eRearmSuccess
  61. {
  62.     RS_CompleteRefit,
  63.     RS_PartialRefit,
  64.     RS_NoRefitPossible,
  65.     RS_RefitUnnecessary
  66. };
  67.  
  68. // Loadout management /////////////////////////////////////////////////////////
  69.  
  70. //
  71. // bool iLoadout.LoadoutActive()
  72. //
  73. // Is there currently a loadout active?
  74. //
  75. prototype bool iLoadout.LoadoutActive();
  76.  
  77. //
  78. // bool GoodToGo()
  79. //
  80. // Is the ship chosen and the loadout valid?
  81. //
  82. prototype bool iLoadout.GoodToGo();
  83.  
  84. //
  85. // eLoadout CurrentLoadout()
  86. //
  87. // The loadout chosen for the current ship
  88. //
  89. prototype eLoadout iLoadout.CurrentLoadout();
  90.  
  91. //
  92. // string LoadoutName( eLoadout loadout )
  93. //
  94. // The name of the loadout chosen for the current ship
  95. //
  96. prototype string iLoadout.LoadoutName( eLoadout loadout );
  97.  
  98. //
  99. // iLoadout.CalculateLoadout
  100. //
  101. // Work out the ship loadout best suited to the given loadout choice.
  102. //
  103. prototype iLoadout.CalculateLoadout( eLoadout loadout );
  104.  
  105. //
  106. // string iLoadout.LoadoutDescription
  107. //
  108. // An HTML description of the current loadout.
  109. //
  110. prototype string iLoadout.LoadoutDescription();
  111.  
  112. //
  113. // eLoadout iLoadout.LoadoutFromInt( int loadout )
  114. //
  115. // Convert the loadout from an int to a member of the loadout enumeration
  116. //
  117. prototype eLoadout iLoadout.LoadoutFromInt( int loadout );
  118.  
  119. //
  120. // int iLoadout.UnusedInternalCargoSlots
  121. //
  122. // Get the spare internal cargo slots
  123. //
  124. prototype int iLoadout.UnusedInternalCargoSlots();
  125.  
  126. // 
  127. // bool iLoadout.RemoteFighterMounted
  128. //
  129. // Do we have a remote fighter loaded out?
  130. //
  131. prototype bool iLoadout.RemoteFighterMounted(); 
  132.  
  133. // 
  134. // iLoadout.RemoveRemoteFighter
  135. //
  136. // Cancel any loaded out remote fighter 
  137. //
  138. prototype iLoadout.RemoveRemoteFighter(); 
  139.  
  140. //
  141. // iLoadout.RegisterAmmoType( string weapon_template )
  142. //
  143. // Register a type of ammo by the template of it's launcher or gun
  144. //
  145. prototype iLoadout.RegisterAmmoType( string weapon_template );
  146.  
  147. //
  148. // iLoadout.RemoveTurretFighters
  149. //
  150. // Take the existing loadout and remove any T-fighters from it. This is needed
  151. // whenever we plan to make the T-Fighters unavailable for a mission - you 
  152. // remove them from the loadout and then remove them from the inventory.
  153. //
  154. prototype iLoadout.RemoveTurretFighters();
  155.  
  156. //
  157. // iLoadout.TurretFightersInLoadout
  158. //
  159. // Get the number of turret fighters loaded out on the player ship
  160. //
  161. prototype int iLoadout.TurretFightersInLoadout();
  162.  
  163. //
  164. // iLoadout.SetDesiredNumberOfTurretFighters( int num_fighters )
  165. //
  166. // Set the desired number of turret fighters for automatic loadouts
  167. //
  168. prototype iLoadout.SetDesiredNumberOfTurretFighters( int num_fighters );
  169.  
  170. // Ship management ///////////////////////////////////////////////////////////
  171.  
  172. // 
  173. // eShip Ship()
  174. //
  175. // Get the current ship.
  176. //
  177. prototype eShip iLoadout.Ship();
  178.  
  179. // 
  180. // SetShip( eShip ship )
  181. //
  182. // Set the ship to fly.
  183. //
  184. prototype iLoadout.SetShip( eShip ship );
  185.  
  186. //
  187. // string ShipName( eShip ship )
  188. //
  189. // Get the name of the given ship
  190. //
  191. prototype string iLoadout.ShipName( eShip ship );
  192.  
  193. //
  194. // string ShipTypeName( eShip ship )
  195. //
  196. // Get the name of the type of the currently loaded out ship
  197. //
  198. prototype string iLoadout.ShipTypeName( eShip ship );
  199.  
  200. //
  201. // StripShip( hship ship )
  202. //
  203. // Strip the player ship (which is passed in) of all its systems and weapons.
  204. // This will cancel the current loadout. 
  205. //
  206. prototype iLoadout.StripShip( hship ship );
  207.  
  208. //
  209. // StripTurretFighters( list turret_fighters )
  210. //
  211. // Strip the given turret fighters of it's loaded out weaponary.
  212. //
  213. prototype iLoadout.StripTurretFighters( list turret_fighters );
  214.  
  215. //
  216. // eRearmSuccess RearmFromJaffs( hship ship )
  217. //
  218. // Attempt to rearm any ammo limited weapons from the player's inventory. 
  219. // Returns a value indicating how successful the rearming went.
  220. //
  221. prototype eRearmSuccess iLoadout.RearmFromJaffs( hship ship );
  222.  
  223. //
  224. // eRearmSuccess RearmFromThirdParty( hship ship, float refit_limit )
  225. //
  226. // Attempt to rearm any ammo limited weapons from a third party. The second 
  227. // argument defines what proportion of the total capacity of the weapon will
  228. // be refilled. i.e. if the refit limit was 0.5 then an assault cannon with a 
  229. // capacity of 1000 rounds will only be topped up by a maximum of 500 rounds.
  230. // Returns a value indicating how successful the rearming went.
  231. //
  232. prototype eRearmSuccess iLoadout.RearmFromThirdParty( 
  233.     hship ship, 
  234.     float refit_limit );
  235.  
  236. // Cargo management ///////////////////////////////////////////////////////////
  237.  
  238. //
  239. // SetCargo( int cargo_type )
  240. //
  241. // Set the cargo to attach to the player ship.
  242. //
  243. prototype iLoadout.SetCargo( int cargo_type );
  244.  
  245. //
  246. // int Cargo()
  247. //
  248. // Get the cargo to attach to the player ship.
  249. //
  250. prototype int iLoadout.Cargo();
  251.  
  252. // Customised loadout functions ///////////////////////////////////////////////
  253.  
  254. //
  255. // StartCustomisedLoadout
  256. //
  257. // Start a customised loadout in native code 
  258. //
  259. prototype iLoadout.StartCustomisedLoadout( 
  260.     hwindow splitter_window, 
  261.     hwindow text_box );
  262.  
  263. //
  264. // EndCustomisedLoadout
  265. //
  266. // Well, that just about wraps it up for this customised loadout.
  267. //
  268. prototype iLoadout.EndCustomisedLoadout();
  269.  
  270. //
  271. // iLoadout.UpdateCustomisedLoadoutTextBox
  272. //
  273. // Update the customised loadout text box
  274. //
  275. prototype iLoadout.UpdateCustomisedLoadoutTextBox();
  276.  
  277. //
  278. // iLoadout.OnCustomiseScreenSelect
  279. //
  280. // When an option is selected on the customised loadout screen, this function
  281. // is called.
  282. //
  283. prototype iLoadout.OnCustomiseScreenSelect();
  284.  
  285. //
  286. // bool iLoadout.OnCustomiseScreenBack
  287. //
  288. // To go back a mode in the customisation 
  289. //
  290. prototype bool iLoadout.OnCustomiseScreenBack();
  291.  
  292. //
  293. // int iLoadout.CustomisedLoadoutMode
  294. //
  295. // Get the current mode in the customised loadout
  296. //
  297. prototype int iLoadout.CustomisedLoadoutMode();
  298.  
  299. //
  300. // bool iLoadout.CargoSpaceWarning()
  301. //
  302. // Are we currently displaying a 'lack of cargo space' warning?
  303. //
  304. prototype bool iLoadout.CargoSpaceWarning();
  305.  
  306. // Window management //////////////////////////////////////////////////////////
  307.  
  308. //
  309. // iLoadout.SetManifestWindow
  310. //
  311. // Sets the manifest window
  312. //
  313. prototype iLoadout.SetManifestWindow( hwindow window );
  314.  
  315. // EOF ////////////////////////////////////////////////////////////////////////
  316.  
  317. #endif // FLUX_LIB
  318.